org.springframework.messaging.tcp.reactor

Class ReactorNettyTcpClient<P>

java.lang.Object

org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient<P>

All Implemented Interfaces:

TcpOperations<P>

public class ReactorNettyTcpClient<P>
extends java.lang.Object
implements TcpOperations<P>

Reactor Netty based implementation of TcpOperations.

Since:

5.0

Author:

Rossen Stoyanchev, Stephane Maldini

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ReactorNettyTcpClient.ReactorNettyHandler
private static class	ReactorNettyTcpClient.StompMessageDecoder<P>

Field Summary

Fields

Modifier and Type	Field and Description
private ChannelGroup	channelGroup
private ReactorNettyCodec<P>	codec
private LoopResources	loopResources
private PoolResources	poolResources
private static int	PUBLISH_ON_BUFFER_SIZE
private Scheduler	scheduler
private boolean	stopping
private TcpClient	tcpClient

Constructor Summary

Constructors

Constructor and Description
ReactorNettyTcpClient(java.util.function.Consumer<<any>> optionsConsumer, ReactorNettyCodec<P> codec) Constructor with a ClientOptions.Builder that can be used to customize Reactor Netty client options.
ReactorNettyTcpClient(java.lang.String host, int port, ReactorNettyCodec<P> codec) Simple constructor with a host and a port.
ReactorNettyTcpClient(TcpClient tcpClient, ReactorNettyCodec<P> codec) Constructor with an externally created TcpClient instance whose lifecycle is expected to be managed externally.

Method Summary

Modifier and Type	Method and Description
ListenableFuture<java.lang.Void>	connect(TcpConnectionHandler<P> handler) Open a new connection.
ListenableFuture<java.lang.Void>	connect(TcpConnectionHandler<P> handler, ReconnectStrategy strategy) Open a new connection and a strategy for reconnecting if the connection fails.
private ListenableFuture<java.lang.Void>	handleShuttingDownConnectFailure(TcpConnectionHandler<P> handler)
private <T> java.util.function.Function<<any>,<any>>	reconnectFunction(ReconnectStrategy reconnectStrategy)
ListenableFuture<java.lang.Void>	shutdown() Shut down and close any open connections.
private <any>	stopScheduler()
private <T> java.util.function.Consumer<T>	updateConnectMono(<any> connectMono)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PUBLISH_ON_BUFFER_SIZE

private static final int PUBLISH_ON_BUFFER_SIZE

See Also:

Constant Field Values

tcpClient

private final TcpClient tcpClient

codec

private final ReactorNettyCodec<P> codec

channelGroup

@Nullable
private final ChannelGroup channelGroup

loopResources

@Nullable
private LoopResources loopResources

poolResources

@Nullable
private PoolResources poolResources

scheduler

private final Scheduler scheduler

stopping

private volatile boolean stopping

Constructor Detail

ReactorNettyTcpClient

public ReactorNettyTcpClient(java.lang.String host,
                             int port,
                             ReactorNettyCodec<P> codec)

Simple constructor with a host and a port.

Parameters:

host - the host to connect to

port - the port to connect to

codec - the code to use

See Also:

StompReactorNettyCodec

ReactorNettyTcpClient

public ReactorNettyTcpClient(java.util.function.Consumer<<any>> optionsConsumer,
                             ReactorNettyCodec<P> codec)

Constructor with a ClientOptions.Builder that can be used to customize Reactor Netty client options.

Note: this constructor manages the lifecycle of the TcpClient and its underlying resources. Please do not customize any of the following options: ChannelGroup, LoopResources, and PoolResources. You may set the disablePool option if you simply want to turn off pooling.

For full control over the initialization and lifecycle of the TcpClient, see ReactorNettyTcpClient(TcpClient, ReactorNettyCodec).

Parameters:

optionsConsumer - consumer to customize client options

codec - the code to use

See Also:

StompReactorNettyCodec

ReactorNettyTcpClient

public ReactorNettyTcpClient(TcpClient tcpClient,
                             ReactorNettyCodec<P> codec)

Constructor with an externally created TcpClient instance whose lifecycle is expected to be managed externally.

Parameters:

tcpClient - the TcpClient instance to use

codec - the code to use

See Also:

StompReactorNettyCodec

Method Detail

connect

public ListenableFuture<java.lang.Void> connect(TcpConnectionHandler<P> handler)

Description copied from interface: TcpOperations

Open a new connection.

Specified by:

connect in interface TcpOperations<P>

Parameters:

handler - a handler to manage the connection

Returns:

a ListenableFuture that can be used to determine when and if the connection is successfully established

connect

public ListenableFuture<java.lang.Void> connect(TcpConnectionHandler<P> handler,
                                                ReconnectStrategy strategy)

Description copied from interface: TcpOperations

Open a new connection and a strategy for reconnecting if the connection fails.

Specified by:

connect in interface TcpOperations<P>

Parameters:

handler - a handler to manage the connection

strategy - a strategy for reconnecting

Returns:

a ListenableFuture that can be used to determine when and if the initial connection is successfully established

handleShuttingDownConnectFailure

private ListenableFuture<java.lang.Void> handleShuttingDownConnectFailure(TcpConnectionHandler<P> handler)

updateConnectMono

private <T> java.util.function.Consumer<T> updateConnectMono(<any> connectMono)

reconnectFunction

private <T> java.util.function.Function<<any>,<any>> reconnectFunction(ReconnectStrategy reconnectStrategy)

shutdown

public ListenableFuture<java.lang.Void> shutdown()

Description copied from interface: TcpOperations

Shut down and close any open connections.

Specified by:

shutdown in interface TcpOperations<P>

Returns:

a ListenableFuture that can be used to determine when and if the connection is successfully closed

stopScheduler

private <any> stopScheduler()